-
Notifications
You must be signed in to change notification settings - Fork 235
docs(bundle): enhance README with detailed overview, usage instructions #5836
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
📚 Branch Preview🔍 Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
Tachometer resultsCurrently, no packages are changed by this PR... |
Pull Request Test Coverage Report for Build 19063791377Details
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me
1st-gen/tools/bundle/README.md
Outdated
|
|
||
| The bundle consists of several key parts: | ||
|
|
||
| - All Spectrum Web Component element registrations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - All Spectrum Web Component element registrations | |
| - All Spectrum Web Component elements registrations |
1st-gen/tools/bundle/README.md
Outdated
| - All Spectrum Web Component element registrations | ||
| - Base classes for all components available for type checking and extension | ||
| - Namespaced icon exports for UI and workflow icons |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you also share one example each for quick reference for the users.
| ```javascript | ||
| import { ActionButton } from '@spectrum-web-components/bundle'; | ||
| import { Button } from '@spectrum-web-components/bundle'; | ||
| import { Tooltip } from '@spectrum-web-components/bundle'; | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you revisit this? This is not correct
Overview
This PR reorganizes the bundle README.md to follow the established documentation standards structure, improving accessibility and consistency with other component documentation.
Changes Made
Structure Reorganization
bash,javascript)Content Improvements
Documentation Standards Compliance
Testing
Related Documentation
This reorganization makes the bundle documentation more accessible, easier to navigate, and consistent with the established documentation standards across the Spectrum Web Components library.